Fetch My Work Capacity

Request

This endpoint returns a summary of a user's work capacity for a provided range of dates.

This endpoint returns structured User objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the users top-level JSON key. Please see our Response Format section for more information.

Path

idintegerrequired

The ID of the Model.

Query

end_datestring, (date)required

The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2016-01-01). The date must be in ISO 8601 format.

start_datestring, (date)required

The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2015-12-16). The date must be in ISO 8601 format.

include_time_off_entriesboolean

Whether to include time off entries in the capacity calculation. Default is false.

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/users/{id}/capacity?end_date=2019-08-24&start_date=2019-08-24&include_time_off_entries=true'

Responses

A list of Users have been retrieved.

Bodyapplication/json

start_datestring, (date)

The start date for calculating my work capacity in YYYY-MM-DD format (e.g. 2012-09-27).

end_datestring, (date)

The end date for calculating my work capacity in YYYY-MM-DD format (e.g. 2012-09-27).

hoursobject

Response

{
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "hours": {
    "property1": 0.1,
    "property2": 0.1
  }
}